<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Services_WorkXpress</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Services_WorkXpress</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Package to access the WorkXpress API</p>
<p class="description"><p>PHP version 5</p></p>
	<ul class="tags">
				<li><span class="field">example:</span> <a href="../__examplesource/exsource__WorkXpress_examples_feature-data_array_format.php_6d7553f3cd123ba8f9d74be57ba8a08a.html">How to use the DATA_ARRAY_FORMAT constants</a></li>
				<li><span class="field">example:</span> <a href="../__examplesource/exsource_vices_WorkXpress_examples_feature-field_format.php_5b1be6338f787098d3ee864e905c87f1.html">How to use the FIELD_FORMAT constants</a></li>
				<li><span class="field">link:</span> PACKAGE_URL</li>
				<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/bsd-license.php">BSD License</a></li>
				<li><span class="field">copyright:</span> 2005-2006 Express Dynamics</li>
				<li><span class="field">author:</span> Scott Gonzalez &lt;<a href="mailto:sgonzalez@expressdynamics.com">sgonzalez@expressdynamics.com</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_WorkXpress.php.html">/WorkXpress.php</a> (line <span class="field">90</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#APPLICATION_ROLE_OCD" title="details" class="const-name">APPLICATION_ROLE_OCD</a> = 					<span class="var-type"> 'ocd'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#APPLICATION_ROLE_PROD" title="details" class="const-name">APPLICATION_ROLE_PROD</a> = 					<span class="var-type"> 'prod'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#APPLICATION_ROLE_QA" title="details" class="const-name">APPLICATION_ROLE_QA</a> = 					<span class="var-type"> 'qa'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#APPLICATION_ROLE_TRAINING" title="details" class="const-name">APPLICATION_ROLE_TRAINING</a> = 					<span class="var-type"> 'training'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#DATA_ARRAY_FORMAT_FULLY_COLLAPSED" title="details" class="const-name">DATA_ARRAY_FORMAT_FULLY_COLLAPSED</a> = 					<span class="var-type"> 1</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#DATA_ARRAY_FORMAT_NOT_COLLAPSED" title="details" class="const-name">DATA_ARRAY_FORMAT_NOT_COLLAPSED</a> = 					<span class="var-type"> 3</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#DATA_ARRAY_FORMAT_PARTIALLY_COLLAPSED" title="details" class="const-name">DATA_ARRAY_FORMAT_PARTIALLY_COLLAPSED</a> = 					<span class="var-type"> 2</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FIELD_ACTION_CLEAR" title="details" class="const-name">FIELD_ACTION_CLEAR</a> = 					<span class="var-type"> 'clear'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FIELD_ACTION_SAVE" title="details" class="const-name">FIELD_ACTION_SAVE</a> = 					<span class="var-type"> 'save'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FIELD_FORMAT_DISPLAYED_VALUE" title="details" class="const-name">FIELD_FORMAT_DISPLAYED_VALUE</a> = 					<span class="var-type"> 'displayed_value'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FIELD_FORMAT_STORED_VALUE" title="details" class="const-name">FIELD_FORMAT_STORED_VALUE</a> = 					<span class="var-type"> 'stored_value'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FIELD_FORMAT_TEXT_ONLY" title="details" class="const-name">FIELD_FORMAT_TEXT_ONLY</a> = 					<span class="var-type"> 'text_only'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RELATION_ACTION_CREATE" title="details" class="const-name">RELATION_ACTION_CREATE</a> = 					<span class="var-type"> 'create'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RELATION_ACTION_DELETE" title="details" class="const-name">RELATION_ACTION_DELETE</a> = 					<span class="var-type"> 'delete'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RELATION_ACTION_RECYCLE" title="details" class="const-name">RELATION_ACTION_RECYCLE</a> = 					<span class="var-type"> 'recycle'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#REQUEST_TYPE_MASS" title="details" class="const-name">REQUEST_TYPE_MASS</a> = 					<span class="var-type"> 2</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#REQUEST_TYPE_STANDARD" title="details" class="const-name">REQUEST_TYPE_STANDARD</a> = 					<span class="var-type"> 1</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_POST_ITEM_ADD" title="details" class="const-name">RULE_EXECUTION_POINT_POST_ITEM_ADD</a> = 					<span class="var-type"> 'POST_ITEM_ADD'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_POST_ITEM_CLONE" title="details" class="const-name">RULE_EXECUTION_POINT_POST_ITEM_CLONE</a> = 					<span class="var-type"> 'POST_ITEM_CLONE'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_POST_ITEM_RECYCLE" title="details" class="const-name">RULE_EXECUTION_POINT_POST_ITEM_RECYCLE</a> = 					<span class="var-type"> 'POST_ITEM_RECYCLE'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_POST_ITEM_UPDATE" title="details" class="const-name">RULE_EXECUTION_POINT_POST_ITEM_UPDATE</a> = 					<span class="var-type"> 'POST_ITEM_UPDATE'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_POST_ITEM_UPDATE_NONRELATION" title="details" class="const-name">RULE_EXECUTION_POINT_POST_ITEM_UPDATE_NONRELATION</a> = 					<span class="var-type"> 'POST_ITEM_UPDATE_NONRELATION'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_POST_ITEM_UPDATE_RUNONCE" title="details" class="const-name">RULE_EXECUTION_POINT_POST_ITEM_UPDATE_RUNONCE</a> = 					<span class="var-type"> 'POST_ITEM_UPDATE_RUNONCE'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_POST_TEMP_ITEM_ADD" title="details" class="const-name">RULE_EXECUTION_POINT_POST_TEMP_ITEM_ADD</a> = 					<span class="var-type"> 'POST_TEMP_ITEM_ADD'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_PRE_ITEM_ADD" title="details" class="const-name">RULE_EXECUTION_POINT_PRE_ITEM_ADD</a> = 					<span class="var-type"> 'PRE_ITEM_ADD'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_PRE_ITEM_CLONE" title="details" class="const-name">RULE_EXECUTION_POINT_PRE_ITEM_CLONE</a> = 					<span class="var-type"> 'PRE_ITEM_CLONE'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_PRE_ITEM_RECYCLE" title="details" class="const-name">RULE_EXECUTION_POINT_PRE_ITEM_RECYCLE</a> = 					<span class="var-type"> 'PRE_ITEM_RECYCLE'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_PRE_ITEM_UPDATE" title="details" class="const-name">RULE_EXECUTION_POINT_PRE_ITEM_UPDATE</a> = 					<span class="var-type"> 'PRE_ITEM_UPDATE'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_EXECUTION_POINT_PRE_TEMP_ITEM_ADD" title="details" class="const-name">RULE_EXECUTION_POINT_PRE_TEMP_ITEM_ADD</a> = 					<span class="var-type"> 'PRE_TEMP_ITEM_ADD'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_TYPE_EXECUTION_POINT" title="details" class="const-name">RULE_TYPE_EXECUTION_POINT</a> = 					<span class="var-type"> 'execpoint'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#RULE_TYPE_RULE" title="details" class="const-name">RULE_TYPE_RULE</a> = 					<span class="var-type"> 'rule'</span>

				</div>
							</div>
		</div>
	</div>


	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
									<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																												
												<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#generateExternalDataField" title="details" class="method-name">generateExternalDataField</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$description</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#generateItem" title="details" class="method-name">generateItem</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$item_type_id</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$item_id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getAPIVersion" title="details" class="method-name">getAPIVersion</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getAuthKey" title="details" class="method-name">getAuthKey</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getDataFromExternalDataField" title="details" class="method-name">getDataFromExternalDataField</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$field_stored_value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getDescriptionFromExternalDataField" title="details" class="method-name">getDescriptionFromExternalDataField</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$field_stored_value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getItemIDFromItem" title="details" class="method-name">getItemIDFromItem</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$item</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getItemTypeIDFromItem" title="details" class="method-name">getItemTypeIDFromItem</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$item</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getRemoteHost" title="details" class="method-name">getRemoteHost</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">object request</span>
										<a href="#loadRequest" title="details" class="method-name">loadRequest</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$request_name</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$request_type</span> = <span class="var-default">self::REQUEST_TYPE_STANDARD</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setAPIVersion" title="details" class="method-name">setAPIVersion</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$api_version</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setAuthKey" title="details" class="method-name">setAuthKey</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$auth_key</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setRemoteHost" title="details" class="method-name">setRemoteHost</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$remote_host</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodgenerateExternalDataField" id="generateExternalDataField"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">generateExternalDataField</span> (line <span class="line-number">469</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates the stored value for an external data storage field from data  and a description</p>
	<ul class="tags">
				<li><span class="field">return:</span> stored value for the external data storage field</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			generateExternalDataField
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$description</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$data</span><span class="var-description">: the data for the external data storage field</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$description</span><span class="var-description">: the data for the external data storage field</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgenerateItem" id="generateItem"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">generateItem</span> (line <span class="line-number">395</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates an item string from an item type id and item id</p>
	<ul class="tags">
				<li><span class="field">return:</span> item</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			generateItem
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$item_type_id</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$item_id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$item_type_id</span><span class="var-description">: item type id</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$item_id</span><span class="var-description">: item id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetAPIVersion" id="getAPIVersion"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getAPIVersion</span> (line <span class="line-number">257</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the API version</p>
	<ul class="tags">
				<li><span class="field">return:</span> API version</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getAPIVersion
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetAuthKey" id="getAuthKey"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAuthKey</span> (line <span class="line-number">267</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the auth key</p>
	<ul class="tags">
				<li><span class="field">return:</span> auth key</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getAuthKey
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDataFromExternalDataField" id="getDataFromExternalDataField"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getDataFromExternalDataField</span> (line <span class="line-number">408</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the data from an external data storage field's stored value</p>
	<ul class="tags">
				<li><span class="field">return:</span> the external data storage field's data</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getDataFromExternalDataField
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$field_stored_value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$field_stored_value</span><span class="var-description">: stored value for the external data storage                 field</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetDescriptionFromExternalDataField" id="getDescriptionFromExternalDataField"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getDescriptionFromExternalDataField</span> (line <span class="line-number">438</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the description from an external data storage field's stored value</p>
	<ul class="tags">
				<li><span class="field">return:</span> the external data storage field's description</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getDescriptionFromExternalDataField
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$field_stored_value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$field_stored_value</span><span class="var-description">: stored value for the external data storage                 field</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetItemIDFromItem" id="getItemIDFromItem"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getItemIDFromItem</span> (line <span class="line-number">369</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the item id from an item string containing the item type id  and the item id</p>
	<ul class="tags">
				<li><span class="field">return:</span> item id</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getItemIDFromItem
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$item</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$item</span><span class="var-description">: item</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetItemTypeIDFromItem" id="getItemTypeIDFromItem"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getItemTypeIDFromItem</span> (line <span class="line-number">382</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the item type id from an item string containing the item type id  and the item id</p>
	<ul class="tags">
				<li><span class="field">return:</span> item id</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getItemTypeIDFromItem
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$item</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$item</span><span class="var-description">: item</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetRemoteHost" id="getRemoteHost"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getRemoteHost</span> (line <span class="line-number">277</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the remote host</p>
	<ul class="tags">
				<li><span class="field">return:</span> remote host</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getRemoteHost
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodloadRequest" id="loadRequest"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">loadRequest</span> (line <span class="line-number">335</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads a request class</p>
	<ul class="tags">
				<li><span class="field">return:</span> class</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object request</span>
		<span class="method-name">
			loadRequest
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$request_name</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$request_type</span> = <span class="var-default">self::REQUEST_TYPE_STANDARD</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$request_name</span><span class="var-description">: WorkXpress API function to load the request for</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$request_type</span><span class="var-description">: which type of request to generate for the API call                 the requests can create standard or mass XML requests</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetAPIVersion" id="setAPIVersion"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setAPIVersion</span> (line <span class="line-number">287</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the API version</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setAPIVersion
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$api_version</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$api_version</span><span class="var-description">: API version</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetAuthKey" id="setAuthKey"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setAuthKey</span> (line <span class="line-number">302</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the auth key</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setAuthKey
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$auth_key</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$auth_key</span><span class="var-description">: auth key</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetRemoteHost" id="setRemoteHost"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setRemoteHost</span> (line <span class="line-number">317</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the remote host</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setRemoteHost
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$remote_host</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$remote_host</span><span class="var-description">: remote host</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constAPPLICATION_ROLE_OCD" id="APPLICATION_ROLE_OCD"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">APPLICATION_ROLE_OCD</span>
			 = <span class="const-default"> 'ocd'</span>
			(line <span class="line-number">95</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">the API is running on the Open Community Development environment</p>
	
	
</div>
<a name="constAPPLICATION_ROLE_PROD" id="APPLICATION_ROLE_PROD"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">APPLICATION_ROLE_PROD</span>
			 = <span class="const-default"> 'prod'</span>
			(line <span class="line-number">110</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">the API is running on a Production environment</p>
	
	
</div>
<a name="constAPPLICATION_ROLE_QA" id="APPLICATION_ROLE_QA"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">APPLICATION_ROLE_QA</span>
			 = <span class="const-default"> 'qa'</span>
			(line <span class="line-number">100</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">the API is running on a Quality Assurance environment</p>
	
	
</div>
<a name="constAPPLICATION_ROLE_TRAINING" id="APPLICATION_ROLE_TRAINING"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">APPLICATION_ROLE_TRAINING</span>
			 = <span class="const-default"> 'training'</span>
			(line <span class="line-number">105</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">the API is running on a Training environment</p>
	
	
</div>
<a name="constDATA_ARRAY_FORMAT_FULLY_COLLAPSED" id="DATA_ARRAY_FORMAT_FULLY_COLLAPSED"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">DATA_ARRAY_FORMAT_FULLY_COLLAPSED</span>
			 = <span class="const-default"> 1</span>
			(line <span class="line-number">125</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">fully collapsed response data array</p>
	
	
</div>
<a name="constDATA_ARRAY_FORMAT_NOT_COLLAPSED" id="DATA_ARRAY_FORMAT_NOT_COLLAPSED"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">DATA_ARRAY_FORMAT_NOT_COLLAPSED</span>
			 = <span class="const-default"> 3</span>
			(line <span class="line-number">135</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uncollapsed response data array</p>
	
	
</div>
<a name="constDATA_ARRAY_FORMAT_PARTIALLY_COLLAPSED" id="DATA_ARRAY_FORMAT_PARTIALLY_COLLAPSED"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">DATA_ARRAY_FORMAT_PARTIALLY_COLLAPSED</span>
			 = <span class="const-default"> 2</span>
			(line <span class="line-number">130</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">partially collapsed response data array</p>
	
	
</div>
<a name="constFIELD_ACTION_CLEAR" id="FIELD_ACTION_CLEAR"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FIELD_ACTION_CLEAR</span>
			 = <span class="const-default"> 'clear'</span>
			(line <span class="line-number">160</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">clear a field</p>
	
	
</div>
<a name="constFIELD_ACTION_SAVE" id="FIELD_ACTION_SAVE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FIELD_ACTION_SAVE</span>
			 = <span class="const-default"> 'save'</span>
			(line <span class="line-number">155</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">save a field</p>
	
	
</div>
<a name="constFIELD_FORMAT_DISPLAYED_VALUE" id="FIELD_FORMAT_DISPLAYED_VALUE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FIELD_FORMAT_DISPLAYED_VALUE</span>
			 = <span class="const-default"> 'displayed_value'</span>
			(line <span class="line-number">145</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">displayed value format</p>
	
	
</div>
<a name="constFIELD_FORMAT_STORED_VALUE" id="FIELD_FORMAT_STORED_VALUE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FIELD_FORMAT_STORED_VALUE</span>
			 = <span class="const-default"> 'stored_value'</span>
			(line <span class="line-number">140</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">stored value format</p>
	
	
</div>
<a name="constFIELD_FORMAT_TEXT_ONLY" id="FIELD_FORMAT_TEXT_ONLY"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FIELD_FORMAT_TEXT_ONLY</span>
			 = <span class="const-default"> 'text_only'</span>
			(line <span class="line-number">150</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">text-only format</p>
	
	
</div>
<a name="constRELATION_ACTION_CREATE" id="RELATION_ACTION_CREATE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RELATION_ACTION_CREATE</span>
			 = <span class="const-default"> 'create'</span>
			(line <span class="line-number">165</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">create a new relation</p>
	
	
</div>
<a name="constRELATION_ACTION_DELETE" id="RELATION_ACTION_DELETE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RELATION_ACTION_DELETE</span>
			 = <span class="const-default"> 'delete'</span>
			(line <span class="line-number">175</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">delete an existing relation</p>
	
	
</div>
<a name="constRELATION_ACTION_RECYCLE" id="RELATION_ACTION_RECYCLE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RELATION_ACTION_RECYCLE</span>
			 = <span class="const-default"> 'recycle'</span>
			(line <span class="line-number">170</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">recycle an existing relation</p>
	
	
</div>
<a name="constREQUEST_TYPE_MASS" id="REQUEST_TYPE_MASS"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">REQUEST_TYPE_MASS</span>
			 = <span class="const-default"> 2</span>
			(line <span class="line-number">120</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">mass request with data separated from items</p>
	
	
</div>
<a name="constREQUEST_TYPE_STANDARD" id="REQUEST_TYPE_STANDARD"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">REQUEST_TYPE_STANDARD</span>
			 = <span class="const-default"> 1</span>
			(line <span class="line-number">115</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">standard request with data nested under items</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_POST_ITEM_ADD" id="RULE_EXECUTION_POINT_POST_ITEM_ADD"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_POST_ITEM_ADD</span>
			 = <span class="const-default"> 'POST_ITEM_ADD'</span>
			(line <span class="line-number">205</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">post item add rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_POST_ITEM_CLONE" id="RULE_EXECUTION_POINT_POST_ITEM_CLONE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_POST_ITEM_CLONE</span>
			 = <span class="const-default"> 'POST_ITEM_CLONE'</span>
			(line <span class="line-number">235</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">post item clone rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_POST_ITEM_RECYCLE" id="RULE_EXECUTION_POINT_POST_ITEM_RECYCLE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_POST_ITEM_RECYCLE</span>
			 = <span class="const-default"> 'POST_ITEM_RECYCLE'</span>
			(line <span class="line-number">215</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">post item recycle rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_POST_ITEM_UPDATE" id="RULE_EXECUTION_POINT_POST_ITEM_UPDATE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_POST_ITEM_UPDATE</span>
			 = <span class="const-default"> 'POST_ITEM_UPDATE'</span>
			(line <span class="line-number">210</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">post item update rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_POST_ITEM_UPDATE_NONRELATION" id="RULE_EXECUTION_POINT_POST_ITEM_UPDATE_NONRELATION"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_POST_ITEM_UPDATE_NONRELATION</span>
			 = <span class="const-default"> 'POST_ITEM_UPDATE_NONRELATION'</span>
			(line <span class="line-number">220</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">post item update on non-relation rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_POST_ITEM_UPDATE_RUNONCE" id="RULE_EXECUTION_POINT_POST_ITEM_UPDATE_RUNONCE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_POST_ITEM_UPDATE_RUNONCE</span>
			 = <span class="const-default"> 'POST_ITEM_UPDATE_RUNONCE'</span>
			(line <span class="line-number">225</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">post item update run-once rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_POST_TEMP_ITEM_ADD" id="RULE_EXECUTION_POINT_POST_TEMP_ITEM_ADD"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_POST_TEMP_ITEM_ADD</span>
			 = <span class="const-default"> 'POST_TEMP_ITEM_ADD'</span>
			(line <span class="line-number">245</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">post temp-item add rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_PRE_ITEM_ADD" id="RULE_EXECUTION_POINT_PRE_ITEM_ADD"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_PRE_ITEM_ADD</span>
			 = <span class="const-default"> 'PRE_ITEM_ADD'</span>
			(line <span class="line-number">190</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">pre item add rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_PRE_ITEM_CLONE" id="RULE_EXECUTION_POINT_PRE_ITEM_CLONE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_PRE_ITEM_CLONE</span>
			 = <span class="const-default"> 'PRE_ITEM_CLONE'</span>
			(line <span class="line-number">230</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">pre item clone rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_PRE_ITEM_RECYCLE" id="RULE_EXECUTION_POINT_PRE_ITEM_RECYCLE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_PRE_ITEM_RECYCLE</span>
			 = <span class="const-default"> 'PRE_ITEM_RECYCLE'</span>
			(line <span class="line-number">200</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">pre item recycle rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_PRE_ITEM_UPDATE" id="RULE_EXECUTION_POINT_PRE_ITEM_UPDATE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_PRE_ITEM_UPDATE</span>
			 = <span class="const-default"> 'PRE_ITEM_UPDATE'</span>
			(line <span class="line-number">195</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">pre item update rule execution point</p>
	
	
</div>
<a name="constRULE_EXECUTION_POINT_PRE_TEMP_ITEM_ADD" id="RULE_EXECUTION_POINT_PRE_TEMP_ITEM_ADD"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_EXECUTION_POINT_PRE_TEMP_ITEM_ADD</span>
			 = <span class="const-default"> 'PRE_TEMP_ITEM_ADD'</span>
			(line <span class="line-number">240</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">pre temp-item add rule execution point</p>
	
	
</div>
<a name="constRULE_TYPE_EXECUTION_POINT" id="RULE_TYPE_EXECUTION_POINT"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_TYPE_EXECUTION_POINT</span>
			 = <span class="const-default"> 'execpoint'</span>
			(line <span class="line-number">185</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">rule type execution point</p>
	
	
</div>
<a name="constRULE_TYPE_RULE" id="RULE_TYPE_RULE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">RULE_TYPE_RULE</span>
			 = <span class="const-default"> 'rule'</span>
			(line <span class="line-number">180</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">rule type rule</p>
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Wed, 22 Nov 2006 11:54:03 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.1</a>
	</p>
	</div></body>
</html>